api: add events subscription support #230

oleg-jukovec · 2022-11-17T16:19:57Z

A user can create watcher by the Connection.NewWatcher() call:

    watcher = conn.NewWatcker("key", func(event WatchEvent) {
        // The callback code.
    })

After that, the watcher callback is invoked for the first time. In this case, the callback is triggered whether or not the key has already been broadcast. All subsequent invocations are triggered with box.broadcast() called on the remote host. If a watcher is subscribed for a key that has not been broadcast yet, the callback is triggered only once, after the registration of the watcher.

If the key is updated while the watcher callback is running, the callback will be invoked again with the latest value as soon as it returns.

Multiple watchers can be created for one key.

If you don’t need the watcher anymore, you can unregister it using the Unregister method:

    watcher.Unregister()

The api is similar to net.box implementation [1].

It also adds a BroadcastRequest to make it easier to send broadcast messages.

https://www.tarantool.io/en/doc/latest/reference/reference_lua/net_box/#conn-watch

I didn't forget about (remove if it is not applicable):

Tests (see documentation for a testing package)
Changelog (see documentation for changelog format)
Documentation (see documentation for documentation style guide)

Related issues:

Closes #119

oleg-jukovec · 2022-11-22T11:47:54Z

There are few things to do after #226 will be merged into master:

Rebase Connection.writeRequest() implementation in connection.go .
Add feature check into Connection.NewWatcher() call (I left TODO in the place).
Add feature check into ConnectionPool.NewWatcher() call (I left TODO in the place).

But it doesn't look critical and can be done quickly. This will not affect the idea of the pull request.

DifferentialOrange · 2022-11-23T09:48:56Z

https://www.tarantool.io/ru/doc/latest/reference/reference_lua/net_box/#conn-watch

It is better to refer to /en/ documentation.

DifferentialOrange

I've try to review it one more time later. It's rather hard to catch on all these concurrency details from the first time (especially if you're not familiar with them).

connection.go

tarantool_test.go

connection.go

oleg-jukovec · 2022-11-23T18:44:50Z

I've try to review it one more time later. It's rather hard to catch on all these concurrency details from the first time (especially if you're not familiar with them).

Thank you! I could recommend to review in this order:

Connection.
ConnectionMulti.
ConnectionPool.

It would be possible to split the commit into several (Connection, ConnectionMulti, ConnectionPool, Connector), but it look like a single feature, so I did not do it.

better0fdead

Hello, thx for patch. I am generally ok, just some small comments.

connection_pool/round_robin.go

connection.go

DifferentialOrange · 2022-11-29T12:18:04Z

If a watcher is subscribed for a key that has not been broadcast yet, the callback is triggered only once

I'm still a bit confused. If a watcher subscribed for a key that has been broadcasted before the subscription, will callback be triggered twice? If yes, with which values? Or will it be triggered for each historical value in their order? Or will it trigger only once for the current key value? If yes, I don't get what "If a watcher is subscribed for a key that has not been broadcast yet, the callback is triggered only once" should mean since they all are triggered only once on bootstrap.

oleg-jukovec · 2022-11-29T12:36:41Z

Or will it trigger only once for the current key value? If yes, I don't get what "If a watcher is subscribed for a key that has not been broadcast yet, the callback is triggered only once" should mean since they all are triggered only once on bootstrap.

It is copy-paste from: https://www.tarantool.io/ru/doc/latest/reference/reference_lua/box_events/#how-a-watcher-works

I think I need to look at the whole paragraph. The last sentence explains what will happen if there are no broadcasts yet. But I can delete the sentence =)

connection.go

watch.go

connection.go

CHANGELOG.md

test_helpers/utils.go

protocol.go

connection.go

tarantool_test.go

connection.go

tarantool_test.go

connection_pool/connection_pool.go

Due to a bug [1], our test workflow fails on Tarantool 1.10. It is a quick fix until the problem is fixed. 1. tarantool/setup-tarantool#37

The patch removes a last newline character from log messages because the character will be added anyway [1][2]. 1. https://pkg.go.dev/log#Logger.Printf 2. https://pkg.go.dev/log#Output Part of #119

A user can create watcher by the Connection.NewWatcher() call: watcher = conn.NewWatcker("key", func(event WatchEvent) { // The callback code. }) After that, the watcher callback is invoked for the first time. In this case, the callback is triggered whether or not the key has already been broadcast. All subsequent invocations are triggered with box.broadcast() called on the remote host. If a watcher is subscribed for a key that has not been broadcast yet, the callback is triggered only once, after the registration of the watcher. If the key is updated while the watcher callback is running, the callback will be invoked again with the latest value as soon as it returns. Multiple watchers can be created for one key. If you don’t need the watcher anymore, you can unregister it using the Unregister method: watcher.Unregister() The api is similar to net.box implementation [1]. It also adds a BroadcastRequest to make it easier to send broadcast messages. 1. https://www.tarantool.io/en/doc/latest/reference/reference_lua/net_box/#conn-watch Closes #119

oleg-jukovec force-pushed the oleg-jukovec/gh-119-watchers-support branch 6 times, most recently from dd9a1fa to 22455f6 Compare November 22, 2022 11:44

oleg-jukovec requested review from DifferentialOrange and better0fdead November 22, 2022 12:09

oleg-jukovec marked this pull request as ready for review November 22, 2022 12:09

oleg-jukovec force-pushed the oleg-jukovec/gh-119-watchers-support branch 3 times, most recently from dafb5e1 to 401de6d Compare November 22, 2022 15:55

oleg-jukovec force-pushed the oleg-jukovec/gh-119-watchers-support branch from 401de6d to 3240a5a Compare November 23, 2022 11:34

DifferentialOrange reviewed Nov 23, 2022

View reviewed changes

oleg-jukovec force-pushed the oleg-jukovec/gh-119-watchers-support branch from 3240a5a to 2725aa3 Compare November 24, 2022 07:28

better0fdead suggested changes Nov 24, 2022

View reviewed changes

connection_pool/round_robin.go Show resolved Hide resolved

connection.go Show resolved Hide resolved

oleg-jukovec force-pushed the oleg-jukovec/gh-119-watchers-support branch 3 times, most recently from 672e012 to f3691d1 Compare November 24, 2022 14:27

better0fdead approved these changes Nov 28, 2022

View reviewed changes

DifferentialOrange reviewed Nov 29, 2022

View reviewed changes

oleg-jukovec force-pushed the oleg-jukovec/gh-119-watchers-support branch 4 times, most recently from 6620388 to 4662c58 Compare November 30, 2022 12:31

oleg-jukovec force-pushed the oleg-jukovec/gh-119-watchers-support branch 5 times, most recently from f4b4d71 to 706b3e6 Compare November 30, 2022 15:31

DifferentialOrange reviewed Dec 1, 2022

View reviewed changes

connection.go Show resolved Hide resolved

connection.go Outdated Show resolved Hide resolved

connection.go Outdated Show resolved Hide resolved

connection.go Outdated Show resolved Hide resolved

oleg-jukovec force-pushed the oleg-jukovec/gh-119-watchers-support branch from 706b3e6 to a719437 Compare December 5, 2022 08:40

DifferentialOrange reviewed Dec 5, 2022

View reviewed changes

oleg-jukovec force-pushed the oleg-jukovec/gh-119-watchers-support branch 3 times, most recently from cda1f1a to c3e2254 Compare December 5, 2022 12:00

oleg-jukovec requested a review from DifferentialOrange December 5, 2022 12:45

DifferentialOrange approved these changes Dec 6, 2022

View reviewed changes

connection.go Show resolved Hide resolved

tarantool_test.go Outdated Show resolved Hide resolved

connection_pool/connection_pool.go Outdated Show resolved Hide resolved

oleg-jukovec force-pushed the oleg-jukovec/gh-119-watchers-support branch 2 times, most recently from e496d79 to c3925d0 Compare December 6, 2022 15:59

oleg-jukovec added 4 commits December 7, 2022 10:33

ci: bump setup-tarantool

50a1156

ci: run ce tests on ubuntu-20.04

cc03989

Due to a bug [1], our test workflow fails on Tarantool 1.10. It is a quick fix until the problem is fixed. 1. tarantool/setup-tarantool#37

code health: unify log messages format

c6ae12d

The patch removes a last newline character from log messages because the character will be added anyway [1][2]. 1. https://pkg.go.dev/log#Logger.Printf 2. https://pkg.go.dev/log#Output Part of #119

oleg-jukovec force-pushed the oleg-jukovec/gh-119-watchers-support branch from c3925d0 to bc79947 Compare December 7, 2022 07:46

oleg-jukovec merged commit 265f96c into master Dec 7, 2022

oleg-jukovec deleted the oleg-jukovec/gh-119-watchers-support branch December 7, 2022 08:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

api: add events subscription support #230

api: add events subscription support #230

oleg-jukovec commented Nov 17, 2022 •

edited

Loading

oleg-jukovec commented Nov 22, 2022 •

edited

Loading

DifferentialOrange commented Nov 23, 2022

DifferentialOrange left a comment

oleg-jukovec commented Nov 23, 2022 •

edited

Loading

better0fdead left a comment

DifferentialOrange commented Nov 29, 2022 •

edited

Loading

oleg-jukovec commented Nov 29, 2022

api: add events subscription support #230

api: add events subscription support #230

Conversation

oleg-jukovec commented Nov 17, 2022 • edited Loading

oleg-jukovec commented Nov 22, 2022 • edited Loading

DifferentialOrange commented Nov 23, 2022

DifferentialOrange left a comment

Choose a reason for hiding this comment

oleg-jukovec commented Nov 23, 2022 • edited Loading

better0fdead left a comment

Choose a reason for hiding this comment

DifferentialOrange commented Nov 29, 2022 • edited Loading

oleg-jukovec commented Nov 29, 2022

oleg-jukovec commented Nov 17, 2022 •

edited

Loading

oleg-jukovec commented Nov 22, 2022 •

edited

Loading

oleg-jukovec commented Nov 23, 2022 •

edited

Loading

DifferentialOrange commented Nov 29, 2022 •

edited

Loading